Updating Elastic API Descriptions#8924
Updating Elastic API Descriptions#8924necusjz merged 6 commits intoAzure:mainfrom jkore1911:features/users/jkore/ElasticAPIDescriptions
Conversation
️✔️Azure CLI Extensions Breaking Change Test
|
|
Hi @jkore1911, |
|
Thank you for your contribution! We will review the pull request and get back to you soon. |
|
The git hooks are available for azure-cli and azure-cli-extensions repos. They could help you run required checks before creating the PR. Please sync the latest code with latest dev branch (for azure-cli) or main branch (for azure-cli-extensions). pip install azdev --upgrade
azdev setup -c <your azure-cli repo path> -r <your azure-cli-extensions repo path>
|
There was a problem hiding this comment.
Pull Request Overview
This PR enriches API command summaries and updates a test scenario with a new OpenAI resource configuration.
- Updated test values for
openAIResourceIdandopenAIResourceEndpointintest_elastic_scenario.py - Expanded docstrings across multiple Elastic monitor commands for clarity and consistency
Reviewed Changes
Copilot reviewed 51 out of 55 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/elastic/azext_elastic/tests/latest/test_elastic_scenario.py | Updated OpenAI resource ID and endpoint in test data |
| src/elastic/azext_elastic/aaz/latest/elastic/monitor/** | Enhanced docstrings for Elastic monitor commands |
| src/elastic/azext_elastic/aaz/latest/elastic/monitor/open_ai_integration/_get_statu.py | Noted inconsistency in command/class naming |
Comments suppressed due to low confidence (2)
src/elastic/azext_elastic/aaz/latest/elastic/monitor/open_ai_integration/_get_statu.py:17
- The class and command name 'GetStatu' appear to have a typo. Rename them to 'GetStatus' and update the command to 'get-status' to match standard naming conventions.
class GetStatu(AAZCommand):
src/elastic/azext_elastic/tests/latest/test_elastic_scenario.py:134
- [nitpick] Add a space after the colon in the 'key' entry for consistency with surrounding dictionary formatting, e.g.,
'key': '9e1bac69b92242129ad1f2373dd06939',.
'key':'9e1bac69b92242129ad1f2373dd06939',
CodeGen Tools Feedback CollectionThank you for using our CodeGen tool. We value your feedback, and we would like to know how we can improve our product. Please take a few minutes to fill our codegen survey |
|
Hi @jkore1911 Release SuggestionsModule: elastic
Notes
|
This checklist is used to make sure that common guidelines for a pull request are followed.
Related command
General Guidelines
azdev style <YOUR_EXT>locally? (pip install azdevrequired)python scripts/ci/test_index.py -qlocally? (pip install wheel==0.30.0required)For new extensions:
About Extension Publish
There is a pipeline to automatically build, upload and publish extension wheels.
Once your pull request is merged into main branch, a new pull request will be created to update
src/index.jsonautomatically.You only need to update the version information in file setup.py and historical information in file HISTORY.rst in your PR but do not modify
src/index.json.